Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New prototype.py module with moyopy-powered AFLOW-style proto-structure labeling #198

Merged
merged 18 commits into from
Feb 9, 2025

Conversation

janosh
Copy link
Owner

@janosh janosh commented Feb 2, 2025

see related PR CompRhys/aviary#96 where a rougher version of this code started. ported here partially because aviary is not on PyPI and so cannot be depended on in pyproject.toml when making package releases.

  • migrate get_mp_energies.py and compile_wbm_test_set.py from aviary get_protostructure_label_from_spglib to moyopy-powered matbench_discovery.structure.prototype.get_protostructure_label
  • update MP energies dataset with new prototype labels (only ~104k / ~154k = ~67% coverage for now, failures to be investigated), TODO also update wbm-summary.csv.gz once failures figured out
  • unit tests for get_protostructure_label
  • supporting (wyckoff-position-multiplicities|wyckoff-relabelings).yaml.gz data files for Wyckoff position multiplicities and relabelings

- rename analyze_symmetry() to get_sym_info_from_structs()
- also split corresponding unit tests
…FLOW-style protostructure labels

- replace aviary's get_protostructure_label_from_spglib with matbench_discovery.structure.prototype.get_protostructure_label in data/mp/get_mp_energies.py and data/wbm/compile_wbm_test_set.py
- add test cases for prototype structure labeling
- update 2023-01-10 mp-energies.csv.gz with moyo-based prototype labels (~50k out of 154k still missing where label generation failed so also keeping the original spglib labels for now)
- publication-ready x/y axis labels
- prefix MAE and R^2 metrics with point count N
- decrease figure size for better readability
Co-authored-by: Rhys Goodall <rhys.goodall@outlook.com>
Co-authored-by: Rhys Goodall <rhys.goodall@outlook.com>
- add test case for ASE Atoms input
- Modify corresponding test cases to use pr_url instead of url
- clean up --models arg parsing in upload_model_preds_to_figshare.py and analyze_geo_opt.py
@janosh
Copy link
Owner Author

janosh commented Feb 9, 2025

thanks a lot @lan496 and @CompRhys for your help on this! 👍

@janosh janosh added analysis New model analysis symmetry Structural symmetry analysis (usually with moyopy, prev. spglib) labels Feb 9, 2025
@janosh janosh merged commit de8c6c7 into main Feb 9, 2025
8 checks passed
@janosh janosh deleted the prototype-module branch February 9, 2025 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analysis New model analysis symmetry Structural symmetry analysis (usually with moyopy, prev. spglib)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants